.max-w-8xl {
    max-width: 100vw;
}

th {
    text-align: left;
}


// EB: not particularly proud of this, but it works for now
// Mintlify uses SSR, so it's not possible to predict whether the components are mounted or not,
// and the Global JS is running asynchronously and injected after the dom.
// We need to wait for the components to be mounted before we can update them, and there are two cases:
// 1. The components are already mounted when the Global JS runs, in which case we can update them immediately.
// 2. The components are not mounted when the Global JS runs, in which case we need to wait for them to be 
// mounted before we can update them. See open-source-tile.mdx for more details in the setInterval. 
// Also, that client side code in the snippet is executed multiple times, so to avoid updating the 
// components multiple times, we use a mix of setInterval and debounce.


const HuggingFace = {
 
 state: {
 models: [],
 datasets: [],
 debounceTimer: null
 },

 renderComponent: function(huggingFaceElement, componentId, isModel) {
 let parentCard = document.getElementById(componentId);
 while (parentCard.tagName !== "A") {
 parentCard = parentCard.parentElement;
 }
 parentCard.href = "https://huggingface.co/" + (isModel ? '' : 'datasets/') + huggingFaceElement.id;

 let stats = document.getElementById(componentId);
 stats.innerHTML = `
 
 
 Downloads ${huggingFaceElement.downloads} | Likes ${huggingFaceElement.likes}`;
 },

 // Update UI components with debounce
 updateComponents: function() {
 clearTimeout(this.state.debounceTimer);
 this.state.debounceTimer = setTimeout(() => {
 [...this.state.models, ...this.state.datasets].forEach(hf => {
 const componentId = `huggingface-${hf.id.split('/')[1]}`;
 if (!document.getElementById(componentId)) {
 return;
 }
 this.renderComponent(hf, componentId, hf.hasOwnProperty('modelId'));
 });
 if (document.getElementById('huggingface-impact')) {
 // update total count of model downloads
 document.getElementById('huggingface-impact-model-downloads').innerHTML = this.state.models.reduce((sum, model) => sum + model.downloads, 0);
 // update total count of dataset downloads
 document.getElementById('huggingface-impact-dataset-downloads').innerHTML = this.state.datasets.reduce((sum, dataset) => sum + dataset.downloads, 0);
 // update total count of combined likes
 document.getElementById('huggingface-impact-combined-likes').innerHTML = [...this.state.models, ...this.state.datasets].reduce((sum, el) => sum + el.likes, 0);
 }
 }, 50);
 },

 // Fetch data from HuggingFace API
 fetchData: async function() {
 try {
 // Fetch models
 const modelsResponse = await fetch('https://huggingface.co/api/models?author=TechWolf');
 this.state.models = await modelsResponse.json();

 // Fetch datasets
 const datasetsResponse = await fetch('https://huggingface.co/api/datasets?author=TechWolf');
 this.state.datasets = await datasetsResponse.json();

 const data = { 
 models: this.state.models, 
 datasets: this.state.datasets 
 };
 this.updateComponents();
 return data;
 } catch (error) {
 console.error('Error fetching HuggingFace data:', error);
 throw error;
 }
 },

 // Stop all interval timers created by open-source-tile.mdx
 stopAllIntervalTimers: function() {
 window.HuggingFaceIntervals.forEach(timer => clearInterval(timer));
 this.updateComponents();
 }
};

HuggingFace.fetchData();

Get the match score between an Employee and a Job

application

A match result between an Employee and a Job.

Simple

A match result between an Employee and a Job.
A match result between an Employee and a Job, including an explanation of what Skills are missing and what Skills are present in the Employee's Skill Profile.

Explained

Not Found

TechWolf Developer Portal

API Reference

Tutorials

Technology

Integrations

Open Source

Request a demo

Support

latest

Getting Started

Architecture

Data Handling

Information Security

Responsible AI Principles

System Design

AI Lifecycle

AI Risk & Regulation

AI Research

Entities

Skill Events

Skill Clusters

External Companies

Metrics & Reports

Welcome

Overview

Authentication

Creating new Employees

Skill Cluster Feedback

Skill Cluster Export

Job and Job Family Creation

Providing Profile Data

Governed Skill Profiles

Entity Creation

Fetching Matches

Configuring Matches

External Company Creation

Linking Vacancies

Skill Cluster Framework

Profile Feedback

Custom Property Definitions

Custom Properties

Integrations Overview

Key concepts

Installation - Employees

Installation - Jobs

How To: Set Up a Report Schedule

How To: Load Export Integration Definitions

How To: Whitelist SFTP server in SAP

Installation

EIB Specification

How it works

SumTotal

What is the Skill Assistant?

Installation in Teams

Installation in Slack

How It Works

Customizations

How It Looks

Installation - Skill Inventory

How To: Load Import Integration Definitions

How To: Create an OAuth2 Client Application

Overview - Employees

Overview - Jobs

Explanation: Skill Harmonization

File-based output integrations

File guidelines

SFTP

S3 File Organization

Explore TechWolf's open source contributions to the AI community

Open Source AI Models & Datasets

Introduction

Versioning Overview

Breaking Changes

Deprecations

Compatible Changes

Get a list of all Domains available in the system.

List Domains

Create Domain

Get Domain information stored in the system.

Get Domain

Submit the most up-to-date Domain information. Any field that is present will overwrite existing values within the system, while absent fields will be left as is.

Update Domain

Delete Domain information stored inside the system. By deleting a Domain, all Skill Clusters linked to this Domain are also deleted.

Delete Domain

Get a list of all Subdomains available in the system.

List Subdomains

Create a new Subdomain in the system that is linked to a Domain.

Create Subdomain

Get the Subdomain information stored in the system.

Get Subdomain

Submit the most up-to-date Subdomain information. Any field that is present will overwrite existing values within the system, while absent fields will be left as is.

Update Subdomain

Delete Subdomain information stored inside the system.

Delete Subdomain

Get a list of all Skill Clusters available in the system.

List Skill Clusters

Create a new Skill Cluster in the system that is linked to a Domain or Subdomain. A Skill Cluster must be linked to a Domain in a 3-level Taxonomy, and it can only be linked to a Subdomain in a 4-level Taxonomy.

Create Skill Cluster

Get the Skill Cluster information stored in the system.

Get Skill Cluster

Submit the most up-to-date Skill Cluster information. Any field that is present will overwrite existing values within the system, while absent fields will be left as is.

Update Skill Cluster

Delete Skill Cluster information stored inside the system.

Delete Skill Cluster

Get a list of all Skills linked to a Skill Cluster.

List Skills

Add Skill

Remove Skill

Get the Skill information stored inside the system for multiple Skills.

Get the Skill information stored in the vocabulary. This can be for either a Skill in the TechWolf vocabulary or a Skill in an external vendor's vocabulary. For TechWolf Skills, meta information such as Skill adoption can also be requested.

Get Skill

Submit the most up-to-date skill description. The description field will overwrite  the existing value in the system, while any other fields will remain unchanged. To revert to the default description provided by TechWolf, set this field to null.

Update Skill

Get a list of changes to the Taxonomy within a certain timeframe.

Get Taxonomy changes

Apply a set of changes to the Taxonomy in the system. The changes are applied in the order they are given in the request body.

Apply Taxonomy changes

Get a list of all Employees available in the system. This can for example be used to keep track of proper synchronisation between your system and the Skill Engine API.

List Employees

Submit new Employee information to initialise their Skill Profile inside the Skill Engine API.

Create Employee

Get the Employee information stored inside the system. As resumes are not stored inside our system, they are not returned in this call.

Get Employee

Submit the most up-to-date Employee information to update their profile inside the system. Any field that is present will overwrite existing values within the system, while absent fields will be left as-is.

Since the Employee resume is deleted after creating a Skill Profile, it is a required field for recalculating the Skill Profile based on the resume. If no resume is provided, the Skill Profile will be recalculated based on the other available properties.

Passing the `null` value removes non-required attributes. Object attributes will be removed when passing `null`, arrays with `[]` and strings with the empty string `''`.

Update Employee

Remove an Employee from the system. This step deletes all information linked exclusively to this Employee. If these need to be removed as well, make sure to do this separately. By deleting an Employee, you delete their Skill Profile history, which cannot be recreated or recovered afterwards.

Delete Employee

Get an export of the Employee Skill Profile to leverage it for user interaction. Check our tutorials for a clear overview of how to get the most out of each format!

Get the Skill Profile for an Employee

Provide feedback about an existing Employee Skill Profile to update it inside
the system. When the `feedback_format` query parameter is `skills`,
the body of the feedback message overwrites, adds or updates Skills in the original profile.
When the `feedback_format` query parameter is `skill_clusters`, this endpoint will change the Skill Cluster
Skills in the Skill Profile to fit the given Skill Cluster proficiency level.


Partially update an Employee Skill Profile with feedback

Get the total number of Employee objects stored inside the system.

Get Employee count

Get adoption metrics across a collection of Employee objects stored in the system, aggregated over their Skills and your Taxonomy.

Get Employee adoption metrics

Retrieve the employability for this Employee. Employability is influenced by two factors:  the number of matching Vacancies (demand) & the number of Employees that could fill those Vacancies (supply). It is reported as a number between 0 and 1, with the upper end indicating that an Employee  has many matching opportunities (= high demand) for which there are not many matching Employees  (= low supply). A lower score indicates fewer opportunities (= low demand),  or that there is already a high supply of those profiles.

Get the employability metric using filters and weights

Search for Employees based on free text

Get all Skill Events of a specified event type linked to an Employee.

List Skill Events of an Employee by event type

Create a new Skill Event for an Employee. This can be used to track the Skill Profile of an Employee over time.

Create a new Skill Event for an Employee

Get a single Skill Event for an Employee.

Get a Skill Event

Update Skill Event

Remove a Skill Event from an Employee. This step deletes all information linked exclusively to this Skill Event. If a Skill Event contained a non-empty Skill Profile, the Employee's Skill Profile is recalculated with the remaining Skill Events.

Delete Skill Event

Get all Interactions linked to an Employee.

List Interactions of an Employee

Create a new Interaction for an Employee.

Create a new Interaction for an Employee

Get an Employee Interaction from an Employee.

Get Employee Interaction

Remove an Employee Interaction from an Employee.

Delete Employee Interaction

![Beta](https://img.shields.io/badge/-Experimental-orange)

This endpoint retrieves Skill suggestions for selected Employees. Users can
customize the response with optional query parameters like language, the
number of suggestions, and the format (Skill Profiles or Skill Clusters). It
supports filtering by Skill types (suggested, validated, rejected). The response
includes detailed Skill suggestions, with translated names and sources, and
optional clustering if selected.


Get the suggestions Skill Profile for selected Employees

Get a list of all Job Families available in the system. This can for example be used to keep track of proper synchronisation between your system and the Skill Engine API.

List Job Families

Submit new Job Family information to initialise their Job Family inside the Skill Engine API.

Create Job Family

Get the Job Family information stored inside the system.

Get Job Family

Submit the most up-to-date Job Family information. Any field that is present will overwrite existing values within the system, while absent fields will be left as-is.

Update Job Family

Delete the Job Family information stored inside the system. By deleting the Job Family, all Job Family Profile Data is also deleted, together with every Job which is linked to this Job Family.

Delete Job Family

Get an export of the Job Family Skill Profile to leverage it for user interaction.

Get the Skill Profile for a Job Family

Provide feedback about an existing Job Family Skill Profile to update it inside
the system. When the `feedback_format` query parameter is `skills`,
the body of the feedback message overwrites, adds or updates Skills in the original profile.


Partially update a Job Family Skill Profile with feedback

Get an export of the Job Family Skill Profile to leverage it for user interaction. The suggested Job Family Skill Profile automatically updates with changes to the Job Family Profile Data or Job Profile Data for any of its underlying Jobs.

Get the suggested Skill Profile for a Job Family

Get a list of all Job Family Profile Data available in the system. This can for example be used to keep track of proper synchronisation between your system and the Skill Engine API.

List Job Family Profile Data

Submit new Job Family Profile Data information to initialise the Job Family inside the Skill Engine API.

Create Job Family Profile Data for a Job Family

Get a single Job Family Profile Data item for a Job Family.

Get Job Family Profile Data

Update Job Family Profile Data

Remove Job Family Profile Data from the system. This step deletes all information linked exclusively to this Job Family Profile Data. It is not possible to delete Skill Profile Feedback via this endpoint, use the Job Family Profile Data Patch endpoint instead.

Delete Job Family Profile Data for a Job Family

Get a list of all Jobs available in the system. This can for example be used to keep track of proper synchronisation between your system and the Skill Engine API.

List Jobs

Submit new Job information to initialise this inside the Skill Engine API. If a Job has a Job Family, the Job Skill Profile will be generated automatically, incorporating all Skills validated for the specified Job Family.

Create Job

Get a Job by its external ID. This can for example be used to keep track of proper synchronisation between your system and the Skill Engine API.

Get Job

Update a Job by its external ID. If you change the Job Family, it will result in the loss of all Skills validated for the previous Job Family and the addition of all Skills validated for the new Job Family. This can for example be used to keep track of proper synchronisation between your system and the Skill Engine API.

Update Job

Delete a Job by its external ID.
      Delete the Job information stored inside the system. By deleting the Job, all Job Profile Data is also deleted.
      Recalculates the Job Family Skill Profile if the Job Family is specified for the Job.

API Documentation

API Versioning

Taxonomy

Employees

Job Families

Jobs

Peer Groups

Vacancies

Courses

Skill Clusters

External Companies

Skills

Organisational Structure

Custom Properties

Matchmaking

Matching Configuration

Export

Reports

Version

Get the match score between an Employee and a Job

Authorizations

Path Parameters

Query Parameters

Response